Advice Response

Response Shape

Multiply's advice engine outputs advice in a JSON format.

Name	Type	Description
message	String	Status of the API request
status	"success" "error"	Whether the API call has been successful
data.engine_output.message	String	Summary information around advice generation
data.engine_output.success	Boolean	Whether advice has been successfully generated
data.plan	Plan	Financial advice output (see below)

Plan

Name	Type	Description
recommendation_groups	RecommendationGroup	Groups of recommendations by theme
recommendations	[Recommendation]	List of recommendations associated with the advice
todos	[Todo]	List of single actions associated with the advice
suitability_report_link	String	Link to Multiply hosted pdf document
_extra_data	ExtraData	Extra data associated with the advice generation

Recommendation Group

A recommendation group is a collection of recommedations geared towards a single theme.

Name	Type	Description
key	String	Unique key of the group
priority	Int	Priority of the group of recommendations
title	String	Title, for display to customer
subtitle	String	Subtitle, for display to customer
factfind_summary	String	Summary of factfind information relevant to the recommendation group theme, for display to customer

Recommendation

A recommendation is a collection of actions the user should take to address a specific need.

Name	Type	Description
id	String	Unique ID of the recommendation
name	String	Recommendation type name
recommendation_group_key	String	Key of associated recommendation group
copy.name	String	Rendered name of the recommendation, for display to customer
copy.title	String	Rendered title of the recommendation, for display to customer
copy.subtitle	String	Rendered subtitle of the recommendation, for display to customer
copy.explanation	String	Rendered explanation of the recommendation, for display to customer

Todo

Todos are single actions that form the users plan. These include actions to set up new products, transfer money between products, increasing contributions etc.

Name	Type	Description
id	String	Unique ID of the action
locked	Boolean	Whether the todo is actionable at the current time
recommendation_group_key	String	Key of associated recommendation group
title	String	Rendered title of the action, for display to customer
subtitle	String	Rendered subtitle of the action, for display to customer
copy.explanation	String	Rendered explanation of the recommendation, for display to customer

Extra Data

Multiply can provide additional data with the advice repsonse. Typically this data is used by partners to render further templates or to provide insight into the output of the advice engine.

Data available includes:

• Individual needs information for the customer, including explanatory steps around how needs have been calculated, e.g.:

{
  "bill_cover_user": {
    "already_allocated": 0.0,
    "explanation_steps": [
      "Mortgage repayment: 0.00 / month",
      "Mortgage or rent plus utilities: 1,700.00 / month",
      "Net income: 2,100.00 / month",
      "Cover adjusted by fraction of household income (0.43) as all adults are eligible for bill cover",
      "Max bill cover based on income: 840.00",
      "Max bill cover: 1,714.29",
      "Final capped shortfall: 728.57"
    ],
    "target_amount": 16.0
  }
}

• Diagnostic information around how Multiply's advice has allocated a customers funds according to their hierarchy of needs

• A list of recommended transactions for the user, e.g.:

[
  {
    "amount": 100.0,
    "source_id": "ASSET_ID_K",
    "source_owner": "user",
    "source_type": "credit_union_account",
    "target_id": "NEW_ASSET_20",
    "target_is_new": true,
    "target_owner": "joint",
    "target_type": "savings_deposit_account",
    "type": "MOVE"
  },
  ...
]

• Wealth projection for the customer up to their retirement age e.g.:

{
  "wealth_projection": {
    "current_wealth": "1100",
    "final_wealth": "1587000.0",
    "wealth_projection": [
      {
        "date": "2022-01-01",
        "goals": [],
        "wealth": "1100"
      },
      {
        "date": "2023-01-01",
        "goals": [],
        "wealth": "40000"
      },
      ...
    ]
  }
}

For more information, please contact support.

Advice Content Customisation

Multiply's advice engine relies on dynamic templates to generate advice content. Multiply can provide a base implementation of content required to generate advice, but we can also customise any fields. In particular, the following fields are customisable:

• Recommendation Copy. This include explanations for each recommendations, titles and subtitles for recommendation content and summary information about a user's factfind"
• Suitability Letter / Report. Multiply renders these in PDF form, and they are templated in an XML format.
• Single Todo Copy

Multiply uses Mustache templates, and these can make use of variables generated as part of the advice process, as well as variables relating to a customer's factfind.

This content is customisable through Multiply's content management dashboard, and Multiply can support adapting our base templates to existing content that you may use in any advice communications. You can find out more by contacting our sales team here.

Sample Response